<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Whisper: embedding_engine.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Whisper
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">embedding_engine.h</div>  </div>
</div>
<div class="contents">
<a href="embedding__engine_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef __EMBEDDING_ENGINE_H__</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define __EMBEDDING_ENGINE_H__ 1</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00005"></a>00005 
<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;<a class="code" href="bit__source_8h.html">bit_source.h</a>&quot;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &quot;<a class="code" href="properties__reader_8h.html">properties_reader.h</a>&quot;</span>
<a name="l00008"></a>00008 
<a name="l00009"></a>00009 <span class="preprocessor">#include &quot;<a class="code" href="types_8h.html">types.h</a>&quot;</span>
<a name="l00010"></a>00010 <span class="preprocessor">#include &quot;<a class="code" href="audio__formats_8h.html">audio_formats.h</a>&quot;</span>
<a name="l00011"></a>00011 
<a name="l00016"></a><a class="code" href="classIEmbeddingEngine.html">00016</a> <span class="keyword">class </span><a class="code" href="classIEmbeddingEngine.html" title="Embedding engine base class.">IEmbeddingEngine</a>
<a name="l00017"></a>00017 {
<a name="l00018"></a>00018 <span class="keyword">public</span>:
<a name="l00019"></a><a class="code" href="classIEmbeddingEngine.html#adc2c704198f68e2d23a713f058122f34">00019</a>         <a class="code" href="classIEmbeddingEngine.html#adc2c704198f68e2d23a713f058122f34">IEmbeddingEngine</a>() : <a class="code" href="classIEmbeddingEngine.html#a7da6f0fa30423edc18aa7beafa47801a">mPropertiesReader</a>(NULL) { }
<a name="l00020"></a><a class="code" href="classIEmbeddingEngine.html#a34cd1e82cd29a489109593e8f7ff3be4">00020</a>         <span class="keyword">virtual</span> <a class="code" href="classIEmbeddingEngine.html#a34cd1e82cd29a489109593e8f7ff3be4">~IEmbeddingEngine</a>() { }
<a name="l00021"></a>00021 
<a name="l00029"></a>00029         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classIEmbeddingEngine.html#abfb86e00c511112aec0cfa1acfb571c8">setPropertiesReader</a>(<a class="code" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a>* pPropertiesReader);
<a name="l00030"></a>00030 
<a name="l00037"></a>00037         <span class="keyword">virtual</span> <a class="code" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a>* <a class="code" href="classIEmbeddingEngine.html#a72cad808a0f21ab863dd3e4eda653374">getPropertiesReader</a>() <span class="keyword">const</span>;
<a name="l00038"></a>00038 
<a name="l00043"></a>00043         <span class="keyword">virtual</span> std::string <a class="code" href="classIEmbeddingEngine.html#a58c6fd3df13135b91956c42b2f3519a6" title="get the abbreviation for the properties reader">getIniSectionName</a>() <span class="keyword">const</span> = 0;
<a name="l00044"></a>00044 
<a name="l00059"></a>00059         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#a0d4c7dd4a9cef7524a016831042094fe" title="hook call for glue code">embedIntoSamples</a>(int8_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak) = 0;
<a name="l00060"></a>00060         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#a0d4c7dd4a9cef7524a016831042094fe" title="hook call for glue code">embedIntoSamples</a>(uint8_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak) = 0;
<a name="l00061"></a>00061         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#a0d4c7dd4a9cef7524a016831042094fe" title="hook call for glue code">embedIntoSamples</a>(int16_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak) = 0;
<a name="l00062"></a>00062         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#a0d4c7dd4a9cef7524a016831042094fe" title="hook call for glue code">embedIntoSamples</a>(uint16_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak) = 0;
<a name="l00063"></a>00063         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#a0d4c7dd4a9cef7524a016831042094fe" title="hook call for glue code">embedIntoSamples</a>(<span class="keywordtype">double</span>* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak) = 0;
<a name="l00064"></a>00064 
<a name="l00082"></a>00082         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#afdd4eb903fce7b7ec14ed171c0df64d7" title="hook call for glue code">extractFromSamples</a>(int8_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pInBuffer) = 0;
<a name="l00083"></a>00083         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#afdd4eb903fce7b7ec14ed171c0df64d7" title="hook call for glue code">extractFromSamples</a>(uint8_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pInBuffer) = 0;
<a name="l00084"></a>00084         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#afdd4eb903fce7b7ec14ed171c0df64d7" title="hook call for glue code">extractFromSamples</a>(int16_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pInBuffer) = 0;
<a name="l00085"></a>00085         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#afdd4eb903fce7b7ec14ed171c0df64d7" title="hook call for glue code">extractFromSamples</a>(uint16_t* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pInBuffer) = 0;
<a name="l00086"></a>00086         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#afdd4eb903fce7b7ec14ed171c0df64d7" title="hook call for glue code">extractFromSamples</a>(<span class="keywordtype">double</span>* pSamples, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pLeak, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pInBuffer) = 0;
<a name="l00087"></a>00087 
<a name="l00091"></a>00091         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classIEmbeddingEngine.html#a17d63e5e13b91c9121444833cf5de626">shutdown</a>() = 0;
<a name="l00092"></a>00092 
<a name="l00097"></a>00097         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#acfc1adf5ae7e28332f825c6f2ae056d2">changeSettings</a>() = 0;
<a name="l00098"></a>00098 
<a name="l00109"></a>00109         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIEmbeddingEngine.html#aaeb36f7905d85f9df65b7ba565419888" title="determine number of processible samples">getNumRequiredSamples</a>() = 0;
<a name="l00110"></a>00110 
<a name="l00117"></a>00117         <span class="keyword">virtual</span> <a class="code" href="namespaceNAudioFormats.html#a0f5b4d2b68d4ba2b34bac333d4f5f808">NAudioFormats::ESamplesFormat</a> <a class="code" href="classIEmbeddingEngine.html#af1afa2bc32d63b5505a27da584c4a474" title="determine whether samples should be converted to double before handed over to an embedding engine...">getSamplesFormat</a>() = 0;
<a name="l00118"></a>00118 
<a name="l00119"></a>00119 <span class="keyword">protected</span>:
<a name="l00123"></a><a class="code" href="classIEmbeddingEngine.html#a7da6f0fa30423edc18aa7beafa47801a">00123</a>         <a class="code" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a>* <a class="code" href="classIEmbeddingEngine.html#a7da6f0fa30423edc18aa7beafa47801a">mPropertiesReader</a>;
<a name="l00124"></a>00124 
<a name="l00125"></a>00125 <span class="keyword">private</span>:
<a name="l00126"></a>00126         <a class="code" href="classIEmbeddingEngine.html#adc2c704198f68e2d23a713f058122f34">IEmbeddingEngine</a>(<span class="keyword">const</span> <a class="code" href="classIEmbeddingEngine.html" title="Embedding engine base class.">IEmbeddingEngine</a>&amp; );
<a name="l00127"></a>00127         <a class="code" href="classIEmbeddingEngine.html" title="Embedding engine base class.">IEmbeddingEngine</a>&amp; <a class="code" href="classIEmbeddingEngine.html#ab1a0ad555daf0b82027ef6c3aba980d9">operator=</a>(<span class="keyword">const</span> <a class="code" href="classIEmbeddingEngine.html" title="Embedding engine base class.">IEmbeddingEngine</a>&amp; );
<a name="l00128"></a>00128 };
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 <span class="preprocessor">#endif // __EMBEDDING_ENGINE_H__</span>
<a name="l00131"></a>00131 <span class="preprocessor"></span>
</pre></div></div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 25 2012 22:00:39 for Whisper by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
